Provider REST API

/cla_provider/api/v1/case/{case_reference}/eligibility_check/

Eligibility_Check
PUT
Parameters: (
case_reference, type: string
[category] type: field
[your_problem_notes] type: string {‘max’: 500, ‘min’: None}
[property_set] type: field
[you] type: field
[partner] type: field
[disputed_savings] type: field
[dependants_young] type: integer
[dependants_old] type: integer
[is_you_or_your_partner_over_60] type: boolean
[has_partner] type: boolean
[on_passported_benefits] type: boolean
[on_nass_benefits] type: boolean
state, type: choice
[specific_benefits] type: field
)
→ EligibilityCheckSerializer(
[category] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[is_you_or_your_partner_over_60] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[disputed_savings] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[reference] type: field {‘max’: 32, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[has_partner] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[notes] type: string {‘max’: 500, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[on_passported_benefits] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[dependants_young] type: integer {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
state, type: choice {‘max’: None, ‘defaultValue’: u’unknown’, ‘readOnly’: False, ‘min’: None}
[specific_benefits] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[partner] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[dependants_old] type: integer {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[your_problem_notes] type: string {‘max’: 500, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[you] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[property_set] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[on_nass_benefits] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
)
Eligibility_Check
GET
Parameters: (
case_reference, type: string
)
→ EligibilityCheckSerializer(
[category] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[is_you_or_your_partner_over_60] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[disputed_savings] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[reference] type: field {‘max’: 32, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[has_partner] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[notes] type: string {‘max’: 500, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[on_passported_benefits] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[dependants_young] type: integer {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
state, type: choice {‘max’: None, ‘defaultValue’: u’unknown’, ‘readOnly’: False, ‘min’: None}
[specific_benefits] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[partner] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[dependants_old] type: integer {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[your_problem_notes] type: string {‘max’: 500, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[you] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[property_set] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[on_nass_benefits] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
)
Eligibility_Check
PATCH
Parameters: (
case_reference, type: string
[category] type: field
[your_problem_notes] type: string {‘max’: 500, ‘min’: None}
[property_set] type: field
[you] type: field
[partner] type: field
[disputed_savings] type: field
[dependants_young] type: integer
[dependants_old] type: integer
[is_you_or_your_partner_over_60] type: boolean
[has_partner] type: boolean
[on_passported_benefits] type: boolean
[on_nass_benefits] type: boolean
state, type: choice
[specific_benefits] type: field
)
→ EligibilityCheckSerializer(
[category] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[is_you_or_your_partner_over_60] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[disputed_savings] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[reference] type: field {‘max’: 32, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[has_partner] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[notes] type: string {‘max’: 500, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[on_passported_benefits] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[dependants_young] type: integer {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
state, type: choice {‘max’: None, ‘defaultValue’: u’unknown’, ‘readOnly’: False, ‘min’: None}
[specific_benefits] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[partner] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[dependants_old] type: integer {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[your_problem_notes] type: string {‘max’: 500, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[you] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[property_set] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[on_nass_benefits] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
)

/cla_provider/api/v1/case/{case_reference}/eligibility_check/is_eligible/

Eligibility_Check
POST
Parameters: (
case_reference, type: string
[category] type: field
[your_problem_notes] type: string {‘max’: 500, ‘min’: None}
[property_set] type: field
[you] type: field
[partner] type: field
[disputed_savings] type: field
[dependants_young] type: integer
[dependants_old] type: integer
[is_you_or_your_partner_over_60] type: boolean
[has_partner] type: boolean
[on_passported_benefits] type: boolean
[on_nass_benefits] type: boolean
state, type: choice
[specific_benefits] type: field
)
→ EligibilityCheckSerializer(
[category] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[is_you_or_your_partner_over_60] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[disputed_savings] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[reference] type: field {‘max’: 32, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[has_partner] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[notes] type: string {‘max’: 500, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[on_passported_benefits] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[dependants_young] type: integer {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
state, type: choice {‘max’: None, ‘defaultValue’: u’unknown’, ‘readOnly’: False, ‘min’: None}
[specific_benefits] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[partner] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[dependants_old] type: integer {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[your_problem_notes] type: string {‘max’: 500, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[you] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[property_set] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[on_nass_benefits] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
)

/cla_provider/api/v1/case/{case_reference}/eligibility_check/validate/

Eligibility_Check
GET
Parameters: (
case_reference, type: string
)
→ EligibilityCheckSerializer(
[category] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[is_you_or_your_partner_over_60] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[disputed_savings] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[reference] type: field {‘max’: 32, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[has_partner] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[notes] type: string {‘max’: 500, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[on_passported_benefits] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[dependants_young] type: integer {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
state, type: choice {‘max’: None, ‘defaultValue’: u’unknown’, ‘readOnly’: False, ‘min’: None}
[specific_benefits] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[partner] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[dependants_old] type: integer {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[your_problem_notes] type: string {‘max’: 500, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[you] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[property_set] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[on_nass_benefits] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
)

/cla_provider/api/v1/case/{case_reference}/personal_details/

Personal_Details
PUT
Parameters: (
case_reference, type: string
[title] type: string {‘max’: 20, ‘min’: None}
[full_name] type: string {‘max’: 400, ‘min’: None}
[postcode] type: string {‘max’: 12, ‘min’: None}
[street] type: string {‘max’: 255, ‘min’: None}
[mobile_phone] type: string {‘max’: 20, ‘min’: None}
[home_phone] type: string {‘max’: 20, ‘min’: None}
[email] type: email {‘max’: 75, ‘min’: None}
[dob] type: date
[ni_number] type: string {‘max’: 10, ‘min’: None}
[contact_for_research] type: boolean
[safe_to_contact] type: choice
[vulnerable_user] type: boolean
)
→ PersonalDetailsSerializer(
[mobile_phone] type: string {‘max’: 20, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[contact_for_research] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[home_phone] type: string {‘max’: 20, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[reference] type: field {‘max’: 32, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[title] type: string {‘max’: 20, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[dob] type: date {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[vulnerable_user] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[has_diversity] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[street] type: string {‘max’: 255, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[postcode] type: string {‘max’: 12, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[full_name] type: string {‘max’: 400, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[ni_number] type: string {‘max’: 10, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[email] type: email {‘max’: 75, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[safe_to_contact] type: choice {‘max’: None, ‘defaultValue’: u’SAFE’, ‘readOnly’: False, ‘min’: None}
)
Personal_Details
POST
Parameters: (
case_reference, type: string
[title] type: string {‘max’: 20, ‘min’: None}
[full_name] type: string {‘max’: 400, ‘min’: None}
[postcode] type: string {‘max’: 12, ‘min’: None}
[street] type: string {‘max’: 255, ‘min’: None}
[mobile_phone] type: string {‘max’: 20, ‘min’: None}
[home_phone] type: string {‘max’: 20, ‘min’: None}
[email] type: email {‘max’: 75, ‘min’: None}
[dob] type: date
[ni_number] type: string {‘max’: 10, ‘min’: None}
[contact_for_research] type: boolean
[safe_to_contact] type: choice
[vulnerable_user] type: boolean
)
→ PersonalDetailsSerializer(
[mobile_phone] type: string {‘max’: 20, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[contact_for_research] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[home_phone] type: string {‘max’: 20, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[reference] type: field {‘max’: 32, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[title] type: string {‘max’: 20, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[dob] type: date {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[vulnerable_user] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[has_diversity] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[street] type: string {‘max’: 255, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[postcode] type: string {‘max’: 12, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[full_name] type: string {‘max’: 400, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[ni_number] type: string {‘max’: 10, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[email] type: email {‘max’: 75, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[safe_to_contact] type: choice {‘max’: None, ‘defaultValue’: u’SAFE’, ‘readOnly’: False, ‘min’: None}
)
Personal_Details
GET
Parameters: (
case_reference, type: string
)
→ PersonalDetailsSerializer(
[mobile_phone] type: string {‘max’: 20, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[contact_for_research] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[home_phone] type: string {‘max’: 20, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[reference] type: field {‘max’: 32, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[title] type: string {‘max’: 20, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[dob] type: date {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[vulnerable_user] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[has_diversity] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[street] type: string {‘max’: 255, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[postcode] type: string {‘max’: 12, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[full_name] type: string {‘max’: 400, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[ni_number] type: string {‘max’: 10, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[email] type: email {‘max’: 75, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[safe_to_contact] type: choice {‘max’: None, ‘defaultValue’: u’SAFE’, ‘readOnly’: False, ‘min’: None}
)
Personal_Details
PATCH
Parameters: (
case_reference, type: string
[title] type: string {‘max’: 20, ‘min’: None}
[full_name] type: string {‘max’: 400, ‘min’: None}
[postcode] type: string {‘max’: 12, ‘min’: None}
[street] type: string {‘max’: 255, ‘min’: None}
[mobile_phone] type: string {‘max’: 20, ‘min’: None}
[home_phone] type: string {‘max’: 20, ‘min’: None}
[email] type: email {‘max’: 75, ‘min’: None}
[dob] type: date
[ni_number] type: string {‘max’: 10, ‘min’: None}
[contact_for_research] type: boolean
[safe_to_contact] type: choice
[vulnerable_user] type: boolean
)
→ PersonalDetailsSerializer(
[mobile_phone] type: string {‘max’: 20, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[contact_for_research] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[home_phone] type: string {‘max’: 20, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[reference] type: field {‘max’: 32, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[title] type: string {‘max’: 20, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[dob] type: date {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[vulnerable_user] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[has_diversity] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[street] type: string {‘max’: 255, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[postcode] type: string {‘max’: 12, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[full_name] type: string {‘max’: 400, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[ni_number] type: string {‘max’: 10, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[email] type: email {‘max’: 75, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[safe_to_contact] type: choice {‘max’: None, ‘defaultValue’: u’SAFE’, ‘readOnly’: False, ‘min’: None}
)

/cla_provider/api/v1/case/{case_reference}/adaptation_details/

Adaptation_Details
PUT
Parameters: (
case_reference, type: string
[bsl_webcam] type: boolean
[minicom] type: boolean
[text_relay] type: boolean
[skype_webcam] type: boolean
[language] type: choice
[notes] type: string
[callback_preference] type: boolean
)
→ AdaptationDetailsSerializer(
[text_relay] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[skype_webcam] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[minicom] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[reference] type: field {‘max’: 32, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[language] type: choice {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[notes] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[bsl_webcam] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[callback_preference] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
)
Adaptation_Details
POST
Parameters: (
case_reference, type: string
[bsl_webcam] type: boolean
[minicom] type: boolean
[text_relay] type: boolean
[skype_webcam] type: boolean
[language] type: choice
[notes] type: string
[callback_preference] type: boolean
)
→ AdaptationDetailsSerializer(
[text_relay] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[skype_webcam] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[minicom] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[reference] type: field {‘max’: 32, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[language] type: choice {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[notes] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[bsl_webcam] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[callback_preference] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
)
Adaptation_Details
GET
Parameters: (
case_reference, type: string
)
→ AdaptationDetailsSerializer(
[text_relay] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[skype_webcam] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[minicom] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[reference] type: field {‘max’: 32, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[language] type: choice {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[notes] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[bsl_webcam] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[callback_preference] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
)
Adaptation_Details
PATCH
Parameters: (
case_reference, type: string
[bsl_webcam] type: boolean
[minicom] type: boolean
[text_relay] type: boolean
[skype_webcam] type: boolean
[language] type: choice
[notes] type: string
[callback_preference] type: boolean
)
→ AdaptationDetailsSerializer(
[text_relay] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[skype_webcam] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[minicom] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[reference] type: field {‘max’: 32, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[language] type: choice {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[notes] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[bsl_webcam] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[callback_preference] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
)

/cla_provider/api/v1/case/{case_reference}/thirdparty_details/

Third_Party_Details
PUT
Parameters: (
case_reference, type: string
personal_details, type: field
[pass_phrase] type: string {‘max’: 255, ‘min’: None}
[reason] type: choice
personal_relationship, type: choice
[personal_relationship_note] type: string {‘max’: 255, ‘min’: None}
[spoke_to] type: boolean
[no_contact_reason] type: string
[organisation_name] type: string {‘max’: 255, ‘min’: None}
)
→ ThirdPartyDetailsSerializer(
[no_contact_reason] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[reference] type: field {‘max’: 32, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
personal_details, type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[reason] type: choice {‘max’: None, ‘defaultValue’: u’‘, ‘readOnly’: False, ‘min’: None}
personal_relationship, type: choice {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[pass_phrase] type: string {‘max’: 255, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[personal_relationship_note] type: string {‘max’: 255, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[spoke_to] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[organisation_name] type: string {‘max’: 255, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
)
Third_Party_Details
POST
Parameters: (
case_reference, type: string
personal_details, type: field
[pass_phrase] type: string {‘max’: 255, ‘min’: None}
[reason] type: choice
personal_relationship, type: choice
[personal_relationship_note] type: string {‘max’: 255, ‘min’: None}
[spoke_to] type: boolean
[no_contact_reason] type: string
[organisation_name] type: string {‘max’: 255, ‘min’: None}
)
→ ThirdPartyDetailsSerializer(
[no_contact_reason] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[reference] type: field {‘max’: 32, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
personal_details, type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[reason] type: choice {‘max’: None, ‘defaultValue’: u’‘, ‘readOnly’: False, ‘min’: None}
personal_relationship, type: choice {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[pass_phrase] type: string {‘max’: 255, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[personal_relationship_note] type: string {‘max’: 255, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[spoke_to] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[organisation_name] type: string {‘max’: 255, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
)
Third_Party_Details
GET
Parameters: (
case_reference, type: string
)
→ ThirdPartyDetailsSerializer(
[no_contact_reason] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[reference] type: field {‘max’: 32, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
personal_details, type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[reason] type: choice {‘max’: None, ‘defaultValue’: u’‘, ‘readOnly’: False, ‘min’: None}
personal_relationship, type: choice {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[pass_phrase] type: string {‘max’: 255, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[personal_relationship_note] type: string {‘max’: 255, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[spoke_to] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[organisation_name] type: string {‘max’: 255, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
)
Third_Party_Details
PATCH
Parameters: (
case_reference, type: string
personal_details, type: field
[pass_phrase] type: string {‘max’: 255, ‘min’: None}
[reason] type: choice
personal_relationship, type: choice
[personal_relationship_note] type: string {‘max’: 255, ‘min’: None}
[spoke_to] type: boolean
[no_contact_reason] type: string
[organisation_name] type: string {‘max’: 255, ‘min’: None}
)
→ ThirdPartyDetailsSerializer(
[no_contact_reason] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[reference] type: field {‘max’: 32, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
personal_details, type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[reason] type: choice {‘max’: None, ‘defaultValue’: u’‘, ‘readOnly’: False, ‘min’: None}
personal_relationship, type: choice {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[pass_phrase] type: string {‘max’: 255, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[personal_relationship_note] type: string {‘max’: 255, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[spoke_to] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[organisation_name] type: string {‘max’: 255, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
)

/cla_provider/api/v1/case/{case_reference}/diagnosis/

Diagnosis
PUT
Parameters: (
case_reference, type: string
current_node_id, type: choice
[state] type: string {‘max’: 50, ‘min’: None}
[category] type: field
[matter_type1] type: field
[matter_type2] type: field
)
→ DiagnosisSerializer(
[category] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[reference] type: field {‘max’: 32, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[version_in_conflict] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[choices] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[matter_type2] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[state] type: string {‘max’: 50, ‘defaultValue’: u’UNKNOWN’, ‘readOnly’: False, ‘min’: None}
[matter_type1] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
current_node_id, type: choice {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[nodes] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
)
Diagnosis
POST
Parameters: (
case_reference, type: string
current_node_id, type: choice
[state] type: string {‘max’: 50, ‘min’: None}
[category] type: field
[matter_type1] type: field
[matter_type2] type: field
)
→ DiagnosisSerializer(
[category] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[reference] type: field {‘max’: 32, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[version_in_conflict] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[choices] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[matter_type2] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[state] type: string {‘max’: 50, ‘defaultValue’: u’UNKNOWN’, ‘readOnly’: False, ‘min’: None}
[matter_type1] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
current_node_id, type: choice {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[nodes] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
)
Diagnosis
PATCH
Parameters: (
case_reference, type: string
current_node_id, type: choice
[state] type: string {‘max’: 50, ‘min’: None}
[category] type: field
[matter_type1] type: field
[matter_type2] type: field
)
→ DiagnosisSerializer(
[category] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[reference] type: field {‘max’: 32, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[version_in_conflict] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[choices] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[matter_type2] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[state] type: string {‘max’: 50, ‘defaultValue’: u’UNKNOWN’, ‘readOnly’: False, ‘min’: None}
[matter_type1] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
current_node_id, type: choice {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[nodes] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
)
Diagnosis
GET
Parameters: (
case_reference, type: string
)
→ DiagnosisSerializer(
[category] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[reference] type: field {‘max’: 32, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[version_in_conflict] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[choices] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[matter_type2] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[state] type: string {‘max’: 50, ‘defaultValue’: u’UNKNOWN’, ‘readOnly’: False, ‘min’: None}
[matter_type1] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
current_node_id, type: choice {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[nodes] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
)
Diagnosis
DELETE
Parameters: (
case_reference, type: string
)
→ DiagnosisSerializer(
[category] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[reference] type: field {‘max’: 32, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[version_in_conflict] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[choices] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[matter_type2] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[state] type: string {‘max’: 50, ‘defaultValue’: u’UNKNOWN’, ‘readOnly’: False, ‘min’: None}
[matter_type1] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
current_node_id, type: choice {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[nodes] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
)

/cla_provider/api/v1/case/{case_reference}/diagnosis/move_down/

Diagnosis
POST
Parameters: (
case_reference, type: string
current_node_id, type: choice
[state] type: string {‘max’: 50, ‘min’: None}
[category] type: field
[matter_type1] type: field
[matter_type2] type: field
)
→ DiagnosisSerializer(
[category] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[reference] type: field {‘max’: 32, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[version_in_conflict] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[choices] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[matter_type2] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[state] type: string {‘max’: 50, ‘defaultValue’: u’UNKNOWN’, ‘readOnly’: False, ‘min’: None}
[matter_type1] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
current_node_id, type: choice {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[nodes] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
)

/cla_provider/api/v1/case/{case_reference}/diagnosis/move_up/

Diagnosis
POST
Parameters: (
case_reference, type: string
current_node_id, type: choice
[state] type: string {‘max’: 50, ‘min’: None}
[category] type: field
[matter_type1] type: field
[matter_type2] type: field
)
→ DiagnosisSerializer(
[category] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[reference] type: field {‘max’: 32, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[version_in_conflict] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[choices] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[matter_type2] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[state] type: string {‘max’: 50, ‘defaultValue’: u’UNKNOWN’, ‘readOnly’: False, ‘min’: None}
[matter_type1] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
current_node_id, type: choice {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[nodes] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
)

/cla_provider/api/v1/case/{case_reference}/feedback/

Feedback
POST
Parameters: (
case_reference, type: string
[comment] type: string {‘max’: 5000, ‘min’: None}
issue, type: choice
)
→ FeedbackSerializer(
[case] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[comment] type: string {‘max’: 5000, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[reference] type: field {‘max’: 32, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[created] type: field {‘max’: None, ‘defaultValue’: datetime.datetime(2015, 9, 3, 21, 41, 53, 332804, tzinfo=<UTC>), ‘readOnly’: True, ‘min’: None}
[modified] type: field {‘max’: None, ‘defaultValue’: datetime.datetime(2015, 9, 3, 21, 41, 53, 332879, tzinfo=<UTC>), ‘readOnly’: True, ‘min’: None}
[created_by] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[provider] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[resolved] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[justified] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
issue, type: choice {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
)
Feedback
GET
Parameters: (
case_reference, type: string
)
→ FeedbackSerializer(
[case] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[comment] type: string {‘max’: 5000, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[reference] type: field {‘max’: 32, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[created] type: field {‘max’: None, ‘defaultValue’: datetime.datetime(2015, 9, 3, 21, 41, 53, 332804, tzinfo=<UTC>), ‘readOnly’: True, ‘min’: None}
[modified] type: field {‘max’: None, ‘defaultValue’: datetime.datetime(2015, 9, 3, 21, 41, 53, 332879, tzinfo=<UTC>), ‘readOnly’: True, ‘min’: None}
[created_by] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[provider] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[resolved] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[justified] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
issue, type: choice {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
)

/cla_provider/api/v1/case/{case_reference}/feedback/{reference}/

Feedback
PUT
Parameters: (
case_reference, type: string
reference, type: string
[comment] type: string {‘max’: 5000, ‘min’: None}
issue, type: choice
)
→ FeedbackSerializer(
[case] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[comment] type: string {‘max’: 5000, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[reference] type: field {‘max’: 32, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[created] type: field {‘max’: None, ‘defaultValue’: datetime.datetime(2015, 9, 3, 21, 41, 53, 332804, tzinfo=<UTC>), ‘readOnly’: True, ‘min’: None}
[modified] type: field {‘max’: None, ‘defaultValue’: datetime.datetime(2015, 9, 3, 21, 41, 53, 332879, tzinfo=<UTC>), ‘readOnly’: True, ‘min’: None}
[created_by] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[provider] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[resolved] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[justified] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
issue, type: choice {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
)
Feedback
GET
Parameters: (
case_reference, type: string
reference, type: string
)
→ FeedbackSerializer(
[case] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[comment] type: string {‘max’: 5000, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[reference] type: field {‘max’: 32, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[created] type: field {‘max’: None, ‘defaultValue’: datetime.datetime(2015, 9, 3, 21, 41, 53, 332804, tzinfo=<UTC>), ‘readOnly’: True, ‘min’: None}
[modified] type: field {‘max’: None, ‘defaultValue’: datetime.datetime(2015, 9, 3, 21, 41, 53, 332879, tzinfo=<UTC>), ‘readOnly’: True, ‘min’: None}
[created_by] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[provider] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[resolved] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[justified] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
issue, type: choice {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
)
Feedback
PATCH
Parameters: (
case_reference, type: string
reference, type: string
[comment] type: string {‘max’: 5000, ‘min’: None}
issue, type: choice
)
→ FeedbackSerializer(
[case] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[comment] type: string {‘max’: 5000, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[reference] type: field {‘max’: 32, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[created] type: field {‘max’: None, ‘defaultValue’: datetime.datetime(2015, 9, 3, 21, 41, 53, 332804, tzinfo=<UTC>), ‘readOnly’: True, ‘min’: None}
[modified] type: field {‘max’: None, ‘defaultValue’: datetime.datetime(2015, 9, 3, 21, 41, 53, 332879, tzinfo=<UTC>), ‘readOnly’: True, ‘min’: None}
[created_by] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[provider] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[resolved] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[justified] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
issue, type: choice {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
)

/cla_provider/api/v1/case/{case_reference}/logs/

Log
GET
Parameters: (
case_reference, type: string
)
→ LogSerializer(
[code] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[level] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[notes] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[created] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[created_by] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[patch] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[timer] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[type] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
)

/cla_provider/api/v1/case/{case_reference}/notes_history/

Case_Notes_History
GET
Parameters: (
case_reference, type: string
)
→ CaseNotesHistorySerializer(
[operator_notes] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[provider_notes] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[type_notes] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[created_by] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[created] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
)

/cla_provider/api/v1/caseExport/

Provider_Extract
POST

/cla_provider/api/v1/category/

Category
GET
→ CategorySerializerBase(
[ecf_available] type: boolean {‘max’: None, ‘defaultValue’: False, ‘readOnly’: False, ‘min’: None}
code, type: string {‘max’: 50, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[mandatory] type: boolean {‘max’: None, ‘defaultValue’: False, ‘readOnly’: False, ‘min’: None}
name, type: string {‘max’: 500, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[description] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
)

/cla_provider/api/v1/category/{code}/

Category
GET
Parameters: (
code, type: string
)
→ CategorySerializerBase(
[ecf_available] type: boolean {‘max’: None, ‘defaultValue’: False, ‘readOnly’: False, ‘min’: None}
code, type: string {‘max’: 50, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[mandatory] type: boolean {‘max’: None, ‘defaultValue’: False, ‘readOnly’: False, ‘min’: None}
name, type: string {‘max’: 500, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[description] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
)

/cla_provider/api/v1/case/

Case
GET
→ CaseListSerializer(
[category] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[diagnosis_state] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[reference] type: string {‘max’: 128, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[created] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[laa_reference] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[eligibility_state] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[modified] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[personal_details] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[provider_accepted] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[requires_action_by] type: choice {‘max’: None, ‘defaultValue’: u’operator’, ‘readOnly’: True, ‘min’: None}
[date_of_birth] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[outcome_code] type: string {‘max’: 50, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[postcode] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[full_name] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[provider_closed] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[outcome_description] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[case_count] type: integer {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[provider_viewed] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
)

/cla_provider/api/v1/case/{reference}/

Case
PUT
Parameters: (
reference, type: string
[outcome_code] type: string {‘max’: 50, ‘min’: None}
)
→ CaseListSerializer(
[category] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[diagnosis_state] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[reference] type: string {‘max’: 128, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[created] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[laa_reference] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[eligibility_state] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[modified] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[personal_details] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[provider_accepted] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[requires_action_by] type: choice {‘max’: None, ‘defaultValue’: u’operator’, ‘readOnly’: True, ‘min’: None}
[date_of_birth] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[outcome_code] type: string {‘max’: 50, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[postcode] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[full_name] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[provider_closed] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[outcome_description] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[case_count] type: integer {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[provider_viewed] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
)
Case
GET
Parameters: (
reference, type: string
)
→ CaseListSerializer(
[category] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[diagnosis_state] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[reference] type: string {‘max’: 128, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[created] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[laa_reference] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[eligibility_state] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[modified] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[personal_details] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[provider_accepted] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[requires_action_by] type: choice {‘max’: None, ‘defaultValue’: u’operator’, ‘readOnly’: True, ‘min’: None}
[date_of_birth] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[outcome_code] type: string {‘max’: 50, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[postcode] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[full_name] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[provider_closed] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[outcome_description] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[case_count] type: integer {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[provider_viewed] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
)
Case
PATCH
Parameters: (
reference, type: string
[outcome_code] type: string {‘max’: 50, ‘min’: None}
)
→ CaseListSerializer(
[category] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[diagnosis_state] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[reference] type: string {‘max’: 128, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[created] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[laa_reference] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[eligibility_state] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[modified] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[personal_details] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[provider_accepted] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[requires_action_by] type: choice {‘max’: None, ‘defaultValue’: u’operator’, ‘readOnly’: True, ‘min’: None}
[date_of_birth] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[outcome_code] type: string {‘max’: 50, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[postcode] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[full_name] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[provider_closed] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[outcome_description] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[case_count] type: integer {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[provider_viewed] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
)

/cla_provider/api/v1/case/{reference}/accept/

Case
POST
Parameters: (
reference, type: string
[outcome_code] type: string {‘max’: 50, ‘min’: None}
)
→ CaseListSerializer(
[category] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[diagnosis_state] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[reference] type: string {‘max’: 128, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[created] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[laa_reference] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[eligibility_state] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[modified] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[personal_details] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[provider_accepted] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[requires_action_by] type: choice {‘max’: None, ‘defaultValue’: u’operator’, ‘readOnly’: True, ‘min’: None}
[date_of_birth] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[outcome_code] type: string {‘max’: 50, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[postcode] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[full_name] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[provider_closed] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[outcome_description] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[case_count] type: integer {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[provider_viewed] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
)

/cla_provider/api/v1/case/{reference}/close/

Case
POST
Parameters: (
reference, type: string
[outcome_code] type: string {‘max’: 50, ‘min’: None}
)
→ CaseListSerializer(
[category] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[diagnosis_state] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[reference] type: string {‘max’: 128, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[created] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[laa_reference] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[eligibility_state] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[modified] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[personal_details] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[provider_accepted] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[requires_action_by] type: choice {‘max’: None, ‘defaultValue’: u’operator’, ‘readOnly’: True, ‘min’: None}
[date_of_birth] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[outcome_code] type: string {‘max’: 50, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[postcode] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[full_name] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[provider_closed] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[outcome_description] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[case_count] type: integer {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[provider_viewed] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
)

/cla_provider/api/v1/case/{reference}/reject/

Case
POST
Parameters: (
reference, type: string
[outcome_code] type: string {‘max’: 50, ‘min’: None}
)
→ CaseListSerializer(
[category] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[diagnosis_state] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[reference] type: string {‘max’: 128, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[created] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[laa_reference] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[eligibility_state] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[modified] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[personal_details] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[provider_accepted] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[requires_action_by] type: choice {‘max’: None, ‘defaultValue’: u’operator’, ‘readOnly’: True, ‘min’: None}
[date_of_birth] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[outcome_code] type: string {‘max’: 50, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[postcode] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[full_name] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[provider_closed] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[outcome_description] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[case_count] type: integer {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[provider_viewed] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
)

/cla_provider/api/v1/case/{reference}/reopen/

Case
POST
Parameters: (
reference, type: string
[outcome_code] type: string {‘max’: 50, ‘min’: None}
)
→ CaseListSerializer(
[category] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[diagnosis_state] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[reference] type: string {‘max’: 128, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[created] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[laa_reference] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[eligibility_state] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[modified] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[personal_details] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[provider_accepted] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[requires_action_by] type: choice {‘max’: None, ‘defaultValue’: u’operator’, ‘readOnly’: True, ‘min’: None}
[date_of_birth] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[outcome_code] type: string {‘max’: 50, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[postcode] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[full_name] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[provider_closed] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[outcome_description] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[case_count] type: integer {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[provider_viewed] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
)

/cla_provider/api/v1/case/{reference}/split/

Case
POST
Parameters: (
reference, type: string
[outcome_code] type: string {‘max’: 50, ‘min’: None}
)
→ CaseListSerializer(
[category] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[diagnosis_state] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[reference] type: string {‘max’: 128, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[created] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[laa_reference] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[eligibility_state] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[modified] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[personal_details] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[provider_accepted] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[requires_action_by] type: choice {‘max’: None, ‘defaultValue’: u’operator’, ‘readOnly’: True, ‘min’: None}
[date_of_birth] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[outcome_code] type: string {‘max’: 50, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[postcode] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[full_name] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[provider_closed] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[outcome_description] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[case_count] type: integer {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[provider_viewed] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
)

/cla_provider/api/v1/user/

User
POST
Parameters: (
username, type: string
first_name, type: string
last_name, type: string
email, type: string
[is_manager] type: boolean
password, type: string
[chs_password] type: string
[chs_organisation] type: string
[chs_user] type: string {‘max’: 500, ‘min’: None}
)
→ StaffSerializer(
username, type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
first_name, type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
last_name, type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[chs_user] type: string {‘max’: 500, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[created] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[chs_password] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[is_manager] type: boolean {‘max’: None, ‘defaultValue’: False, ‘readOnly’: False, ‘min’: None}
[last_login] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[chs_organisation] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[provider] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
password, type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
email, type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
)
User
GET
→ StaffSerializer(
username, type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
first_name, type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
last_name, type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[chs_user] type: string {‘max’: 500, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[created] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[chs_password] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[is_manager] type: boolean {‘max’: None, ‘defaultValue’: False, ‘readOnly’: False, ‘min’: None}
[last_login] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[chs_organisation] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[provider] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
password, type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
email, type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
)

/cla_provider/api/v1/user/{user__username}/

User
GET
Parameters: (
user__username, type: string
)
→ StaffSerializer(
username, type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
first_name, type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
last_name, type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[chs_user] type: string {‘max’: 500, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[created] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[chs_password] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[is_manager] type: boolean {‘max’: None, ‘defaultValue’: False, ‘readOnly’: False, ‘min’: None}
[last_login] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[chs_organisation] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[provider] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
password, type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
email, type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
)

/cla_provider/api/v1/user/{user__username}/password_reset/

User
POST
Parameters: (
user__username, type: string
username, type: string
first_name, type: string
last_name, type: string
email, type: string
[is_manager] type: boolean
password, type: string
[chs_password] type: string
[chs_organisation] type: string
[chs_user] type: string {‘max’: 500, ‘min’: None}
)
→ StaffSerializer(
username, type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
first_name, type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
last_name, type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[chs_user] type: string {‘max’: 500, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[created] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[chs_password] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[is_manager] type: boolean {‘max’: None, ‘defaultValue’: False, ‘readOnly’: False, ‘min’: None}
[last_login] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[chs_organisation] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[provider] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
password, type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
email, type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
)

/cla_provider/api/v1/user/{user__username}/reset_lockout/

User
POST
Parameters: (
user__username, type: string
username, type: string
first_name, type: string
last_name, type: string
email, type: string
[is_manager] type: boolean
password, type: string
[chs_password] type: string
[chs_organisation] type: string
[chs_user] type: string {‘max’: 500, ‘min’: None}
)
→ StaffSerializer(
username, type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
first_name, type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
last_name, type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[chs_user] type: string {‘max’: 500, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[created] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[chs_password] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[is_manager] type: boolean {‘max’: None, ‘defaultValue’: False, ‘readOnly’: False, ‘min’: None}
[last_login] type: datetime {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[chs_organisation] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[provider] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
password, type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
email, type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
)

/cla_provider/api/v1/event/{action}/

Event
GET
Parameters: (
action, type: string
)

/cla_provider/api/v1/adaptations/

Adaptation_Details_Metadata
POST
Parameters: (
[bsl_webcam] type: boolean
[minicom] type: boolean
[text_relay] type: boolean
[skype_webcam] type: boolean
[language] type: choice
[notes] type: string
[callback_preference] type: boolean
)
→ AdaptationDetailsSerializer(
[text_relay] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[skype_webcam] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[minicom] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[reference] type: field {‘max’: 32, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[language] type: choice {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[notes] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[bsl_webcam] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[callback_preference] type: boolean {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
)

/cla_provider/api/v1/mattertype/

Matter_Type
GET
→ MatterTypeSerializerBase(
[category] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
code, type: string {‘max’: 4, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
description, type: string {‘max’: 255, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
level, type: choice {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
)

/cla_provider/api/v1/mattertype/{pk}/

Matter_Type
GET
Parameters: (
pk, type: string
)
→ MatterTypeSerializerBase(
[category] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
code, type: string {‘max’: 4, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
description, type: string {‘max’: 255, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
level, type: choice {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
)

/cla_provider/api/v1/mediacode/

Media_Code
GET
→ MediaCodeSerializerBase(
code, type: string {‘max’: 20, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[group] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
name, type: string {‘max’: 128, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
)

/cla_provider/api/v1/mediacode/{pk}/

Media_Code
GET
Parameters: (
pk, type: string
)
→ MediaCodeSerializerBase(
code, type: string {‘max’: 20, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[group] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
name, type: string {‘max’: 128, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
)

/cla_provider/api/v1/csvupload/

Csv_Upload
POST
Parameters: (
[comment] type: string
body, type: field
month, type: date
)
→ CSVUploadSerializer(
[comment] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
body, type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[rows] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[created] type: field {‘max’: None, ‘defaultValue’: datetime.datetime(2015, 9, 3, 21, 41, 53, 350913, tzinfo=<UTC>), ‘readOnly’: True, ‘min’: None}
[modified] type: field {‘max’: None, ‘defaultValue’: datetime.datetime(2015, 9, 3, 21, 41, 53, 350986, tzinfo=<UTC>), ‘readOnly’: True, ‘min’: None}
[created_by] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
month, type: date {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[provider] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[id] type: integer {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
)
Csv_Upload
GET
→ CSVUploadSerializer(
[comment] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
body, type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[rows] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[created] type: field {‘max’: None, ‘defaultValue’: datetime.datetime(2015, 9, 3, 21, 41, 53, 350913, tzinfo=<UTC>), ‘readOnly’: True, ‘min’: None}
[modified] type: field {‘max’: None, ‘defaultValue’: datetime.datetime(2015, 9, 3, 21, 41, 53, 350986, tzinfo=<UTC>), ‘readOnly’: True, ‘min’: None}
[created_by] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
month, type: date {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[provider] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[id] type: integer {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
)

/cla_provider/api/v1/csvupload/{pk}/

Csv_Upload
PUT
Parameters: (
pk, type: string
[comment] type: string
body, type: field
month, type: date
)
→ CSVUploadSerializer(
[comment] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
body, type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[rows] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[created] type: field {‘max’: None, ‘defaultValue’: datetime.datetime(2015, 9, 3, 21, 41, 53, 350913, tzinfo=<UTC>), ‘readOnly’: True, ‘min’: None}
[modified] type: field {‘max’: None, ‘defaultValue’: datetime.datetime(2015, 9, 3, 21, 41, 53, 350986, tzinfo=<UTC>), ‘readOnly’: True, ‘min’: None}
[created_by] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
month, type: date {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[provider] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[id] type: integer {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
)
Csv_Upload
GET
Parameters: (
pk, type: string
)
→ CSVUploadSerializer(
[comment] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
body, type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[rows] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[created] type: field {‘max’: None, ‘defaultValue’: datetime.datetime(2015, 9, 3, 21, 41, 53, 350913, tzinfo=<UTC>), ‘readOnly’: True, ‘min’: None}
[modified] type: field {‘max’: None, ‘defaultValue’: datetime.datetime(2015, 9, 3, 21, 41, 53, 350986, tzinfo=<UTC>), ‘readOnly’: True, ‘min’: None}
[created_by] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
month, type: date {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[provider] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[id] type: integer {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
)
Csv_Upload
PATCH
Parameters: (
pk, type: string
[comment] type: string
body, type: field
month, type: date
)
→ CSVUploadSerializer(
[comment] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
body, type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[rows] type: field {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[created] type: field {‘max’: None, ‘defaultValue’: datetime.datetime(2015, 9, 3, 21, 41, 53, 350913, tzinfo=<UTC>), ‘readOnly’: True, ‘min’: None}
[modified] type: field {‘max’: None, ‘defaultValue’: datetime.datetime(2015, 9, 3, 21, 41, 53, 350986, tzinfo=<UTC>), ‘readOnly’: True, ‘min’: None}
[created_by] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
month, type: date {‘max’: None, ‘defaultValue’: None, ‘readOnly’: False, ‘min’: None}
[provider] type: string {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
[id] type: integer {‘max’: None, ‘defaultValue’: None, ‘readOnly’: True, ‘min’: None}
)